New WPHookHelper utility class, incl PHP 8.0+ named param helper
#2148
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
... as it is not currently used anywhere in the WPCS codebase.
The "hook" related property is only used by a small set of sniffs, so are better placed in a dedicated class. This commit moves the `$hookInvokeFunctions` property to a new `WordPressCS\WordPress\Helpers\WPHookHelper` class and starts using that class in the relevant sniffs. Note: * The property is now `private` (and `static`). * Access to the property can be obtained via the new `WPHookHelper::get_functions()` method. * This new method can also pre-filter the list to only return thos functions which are not specifically to invoke deprecated hooks. Related to 1465
... to support retrieving the hook name parameters from a stack of parameters, while supporting PHP 8.0+ function calls using named arguments. This new method will be tested via the implementations in the `ValidHookName` and the `PrefixAllGlobals` sniffs.
dingo-d
approved these changes
Dec 14, 2022
GaryJones
requested changes
Dec 15, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sniff: remove the $hookFunctions property
... as it is not currently used anywhere in the WPCS codebase.
Move "hook" related utilities to dedicated WPHookHelper
The "hook" related property is only used by a small set of sniffs, so are better placed in a dedicated class.
This commit moves the
$hookInvokeFunctionsproperty to a newWordPressCS\WordPress\Helpers\WPHookHelperclass and starts using that class in the relevant sniffs.Note:
private(andstatic).WPHookHelper::get_functions()method.Related to #1465
WPHookHelper: add new get_hook_name_param() method
... to support retrieving the hook name parameters from a stack of parameters, while supporting PHP 8.0+ function calls using named arguments.
This new method will be tested via the implementations in the
ValidHookNameand thePrefixAllGlobalssniffs (upcoming).